/*
   Copyright 2011 James Bowling

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package com.armedia.dctm.constraints;

import com.documentum.fc.client.IDfPersistentObject;
import com.documentum.fc.client.IDfSession;
import com.documentum.fc.common.DfException;

/**
 * Interface that abstractly defines a data integrity constraint.  Implementors might
 * consist of the following:
 * - not null 
 * - unique key
 * - primary key
 * - foreign key
 * - check 
 * @author jbowling
 */
public interface Constraint {
	
	/**
	 * The check method is to be called when an object is saved to check that the 
	 * constraint implemented by this interface has been satisfied.
	 * @param typedObject
	 * @throws DfException
	 */
	public void check(IDfPersistentObject persistentObject) throws DfException;
	
	/**
	 * The checkAll method is to be called when the constraint 
	 * implemented by this interface is being enabled. 
	 * (i.e. - the constraint is enabled if all objects pass the check)
	 * @param session
	 * @throws DfException
	 */
	public void checkAll(IDfSession session) throws DfException;

}
